/*
 * Copyright (c) 2007, 2008 fr3@K <freak@fsfoundry.org>
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef MANKA__DEFAULT_ARENA_HPP
#define MANKA__DEFAULT_ARENA_HPP

#include <manka/arena_allocator.hpp>

#include <cstddef>

namespace manka
{

    /** A operator <tt>new</tt>/<tt>delete</tt> memory arena.
     *
     * @par Thread Safty
     * @e Distinct @e objects: Safe.@n
     * @e Shared @e objects: Safe.
     * 
     * @par Concepts:
     * MemoryArena
     */
    class default_arena
    {
    public:
        /** Memory allocation.
         *
         * @param bytes Size in bytes to allocate.
         *
         * @throws std::bad_alloc Thrown on failure.
         */
        void* allocate(std::size_t bytes);
        
        /** Memory deallocation.
         *
         * This function is used to deallocate memory previously allocated from
         * this arena.
         * 
         * @param ptr Pointer to memory previously allocated from this arena.
         * @param bytes Size in bytes of memory pointed by \c ptr.
         */
        void deallocate(void* ptr, std::size_t bytes);

        /** Capability query.
         *
         * This function is used to query the capability of this arena, i.e.
         * the largest allocation size in bytes that can be potentially
         * satisfied.
         */
        std::size_t max_bytes() const;

        /** Get a allocator instance.
         *
         * This function returns a allocator instance that is bound to this
         * memory arena.
         */
        arena_allocator<default_arena, void>
        get_allocator();
    };
    
} // namespace manka

#endif // !MANKA__DEFAULT_ARENA_HPP
